/*
 * Copyright 2013-2019 Xia Jun(3979434@qq.com).
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 ***************************************************************************************
 *                                                                                     *
 *                        Website : http://www.farsunset.com                           *
 *                                                                                     *
 ***************************************************************************************
 */
package com.master.demo.im.service;


import com.baomidou.mybatisplus.extension.service.IService;
import com.master.common.api.IPageInfo;
import com.master.common.api.Query;
import com.master.common.api.ResponseInfo;
import com.master.demo.im.pojo.command.SessionCommand;
import com.master.demo.im.pojo.entity.Session;
import com.master.demo.im.pojo.vo.SessionVO;

import java.util.List;

/**
 * 在线信息接口
 *
 * @author: Yang
 * @date: 2022/07/05
 * @version: 1.0.0
 * Copyright Ⓒ 2022 Master Computer Corporation Limited All rights reserved.
 */
public interface ISessionService extends IService<Session> {

    /**
     * 查询在线会话信息分页列表
     *
     * @param query 查询条件
     * @return 在线会话信息集合
     */
    ResponseInfo<IPageInfo<SessionVO>> pageSession(Query query);

    /**
     * 查询在线会话信息列表
     *
     * @param query 查询条件
     * @return 在线会话信息集合
     */
    ResponseInfo<List<SessionVO>> listSession(Query query);

    /**
     * 根据主键查询在线会话信息
     *
     * @param id 在线会话信息主键
     * @return 在线会话信息
     */
    ResponseInfo<SessionVO> getSessionById(Long id);

    /**
     * 新增在线会话信息
     *
     * @param command 在线会话信息
     * @return 结果
     */
    ResponseInfo saveSession(SessionCommand command);

    /**
     * 修改在线会话信息
     *
     * @param command 在线会话信息
     * @return 结果
     */
    ResponseInfo updateSession(SessionCommand command);

    /**
     * 批量删除在线会话信息
     *
     * @param ids 需要删除的在线会话信息主键集合
     * @return 结果
     */
    ResponseInfo removeSessionByIds(List<Long> ids);

    /**
     * 删除在线会话信息信息
     *
     * @param id 在线会话信息主键
     * @return 结果
     */
    ResponseInfo removeSessionById(Long id);

    /**
     * 更新用户是否在线状态
     *
     * @param uid    用户id
     * @param nid    netty id
     * @param status 状态 0：离线；1：在线
     * @return
     */
    ResponseInfo updateStatus(String uid, String nid, Integer status);

    /**
     * 开启Apns
     *
     * @param uid         用户id
     * @param deviceToken 设备token
     * @return
     */
    ResponseInfo openApns(String uid, String deviceToken);

    /**
     * 关闭Apns
     *
     * @param uid 用户id
     * @return
     */
    ResponseInfo closeApns(String uid);

}
